Skip to content

docs: enhance custom modes documentation with overriding instructions…#140

Merged
hannesrudolph merged 1 commit into
mainfrom
global-modes
Apr 16, 2025
Merged

docs: enhance custom modes documentation with overriding instructions…#140
hannesrudolph merged 1 commit into
mainfrom
global-modes

Conversation

@hannesrudolph
Copy link
Copy Markdown
Collaborator

@hannesrudolph hannesrudolph commented Apr 16, 2025

… and use cases


Important

Enhances custom-modes.md with instructions for overriding default modes, configuration precedence, and use cases.

  • Documentation Enhancements:
    • Adds instructions for overriding default modes in custom-modes.md.
    • Details on global and project-specific mode overrides.
    • Lists common use cases for overriding default modes.
  • Configuration Precedence:
    • Clarifies that project-specific overrides take precedence over global and default configurations.
  • Use Cases:
    • Provides examples such as restricting file access, specializing behavior, adding custom instructions, and changing available tools.

This description was created by Ellipsis for d65da4d. It will automatically update as commits are pushed.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
roo-code-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2025 11:29pm

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 16, 2025
@hannesrudolph hannesrudolph merged commit ae39ece into main Apr 16, 2025
3 checks passed
@hannesrudolph hannesrudolph deleted the global-modes branch April 16, 2025 23:30
Copy link
Copy Markdown
Contributor

@ellipsis-dev ellipsis-dev Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to d65da4d in 1 minute and 12 seconds

More details
  • Looked at 85 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 drafted comments based on config settings.
1. docs/features/custom-modes.md:156
  • Draft comment:
    The explanation of configuration precedence is clear, but note that it’s somewhat repeated later in the 'Overriding Default Modes' section. Consider consolidating or cross-referencing to avoid redundancy.
  • Reason this comment was not posted:
    Comment was on unchanged code.
2. docs/features/custom-modes.md:297
  • Draft comment:
    The bullet list of common use cases is clear. For consistency with other sections, consider using uniform bullet symbols throughout the doc.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
3. docs/features/custom-modes.md:305
  • Draft comment:
    The tip box formatting using '::::tip' is nicely done. Ensure that similar docs follow the same structured tip syntax for consistency.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
4. docs/features/custom-modes.md:254
  • Draft comment:
    The JSON example for overriding modes globally is well formatted. Be sure to double-check escaping rules (e.g., double backslashes in regex) to keep consistency with other parts of the documentation.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
5. docs/features/custom-modes.md:156
  • Draft comment:
    Consider consolidating the repeated configuration precedence details. The document mentions twice that project-specific configurations override global and default settings (e.g., lines 156 and 294). A single, clear explanation or a reference would reduce redundancy.
  • Reason this comment was not posted:
    Comment was on unchanged code.
6. docs/features/custom-modes.md:248
  • Draft comment:
    The UI instructions (e.g., 'Click the icon') are clear. For added clarity, consider linking to a UI guide or including a screenshot reference to help users quickly identify these UI elements.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None

Workflow ID: wflow_ztCw7SYohLzHlcJd


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant